﻿using System;

namespace CommonUtils.CommandLine
{
    /// <summary>
    /// Command line item short description as attribute
    /// </summary>
    [AttributeUsage(AttributeTargets.Method, Inherited = true, AllowMultiple = false)]
    public class CommandLineItemDescriptionAttribute: Attribute
    {
        #region Properties

        /// <summary>
        /// Text description of item
        /// </summary>
        public string Description
        {
            get;
            private set;
        }

        #endregion

        #region Constructors

        /// <summary>
        /// Default constructor
        /// </summary>
        /// <param name="description">Text description of item</param>
        public CommandLineItemDescriptionAttribute(string description)
        {
            Description = description;
        }

        #endregion
    }
}